<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>AMBHAS: ambhas.sunlib.sun Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">AMBHAS
   
   </div>
   
  </td>
  
  
  
   
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
   
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classambhas_1_1sunlib_1_1sun.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">ambhas.sunlib.sun Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="ambhas::sunlib::sun" -->
<p><a href="classambhas_1_1sunlib_1_1sun-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#a75b1eb14d5e4d9089ff5b11cd63500e4">__init__</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#ac538824283d3a844a6cdf862fed41191">hourly_ETR</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#a7463e325e5c741f3d43cf6c4435cd126">solar_zenith_angle</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#ab44f5c73c93e559e622cdd6f160fd622">daily_ETR</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#a759c8e36b8787b720063b47e1fec00a0">set_rise</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#a51d1a09929fc7cb88ff2ed2b09e93708">doy</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#a7f1a949d69b309ea54f797fcfcec0734">lon_deg</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#ad323cbbcfd71b3b895a951f3037b54a9">ze</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#a60e5d58a61ed47ad507123fb014d0161">dr</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#ae89daab3f0dfe9b266bf799841d09bf5">N</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><div class="fragment"><pre class="fragment">
This class estimate extral-terrestial solar radiation,
sunset time, sunrise time, daylight hours

Based on the article:
    Empirical Model for Estimating Global Solar Radiation
    on Horizontal Surfaces for Selected Cities in 
    the Six Geopolitical Zones in Nigeria
By:
    M.S. Okundamiya and A.N. Nzeako

    
Example:
    lat_deg = 11
    lon_deg = 76
    doy = 180
    foo = sun(doy, lat_deg, lon_deg)
    hourly_etr = foo.hourly_ETR(11.0)
    daily_etr = foo.daily_ETR()
    risetime, settime = foo.set_rise()
</pre></div> 
<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00013">13</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a75b1eb14d5e4d9089ff5b11cd63500e4"></a><!-- doxytag: member="ambhas::sunlib::sun::__init__" ref="a75b1eb14d5e4d9089ff5b11cd63500e4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def <a class="el" href="classambhas_1_1sunlib_1_1sun.html#a75b1eb14d5e4d9089ff5b11cd63500e4">ambhas.sunlib.sun.__init__</a> </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>doy</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>lat_deg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>lon_deg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>ze</em> = <code>5.5</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">initialise the class
Input:
    doy:            day of year
    lat_deg:        latitude in degree ( south is negative)
    lon_deg:        longitude in degree (west is negative)
    ze :            time zone in hour
</pre></div> 
<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00037">37</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab44f5c73c93e559e622cdd6f160fd622"></a><!-- doxytag: member="ambhas::sunlib::sun::daily_ETR" ref="ab44f5c73c93e559e622cdd6f160fd622" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def <a class="el" href="classambhas_1_1sunlib_1_1sun.html#ab44f5c73c93e559e622cdd6f160fd622">ambhas.sunlib.sun.daily_ETR</a> </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">
Returns the daily Extra Terrestial Radiation (ETR)
Input:
    
Output:
    
</pre></div> 
<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00112">112</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<a class="anchor" id="ac538824283d3a844a6cdf862fed41191"></a><!-- doxytag: member="ambhas::sunlib::sun::hourly_ETR" ref="ac538824283d3a844a6cdf862fed41191" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def <a class="el" href="classambhas_1_1sunlib_1_1sun.html#ac538824283d3a844a6cdf862fed41191">ambhas.sunlib.sun.hourly_ETR</a> </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>tc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">
Input:
    tc:     local time in hours
</pre></div> 
<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00071">71</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<a class="anchor" id="a759c8e36b8787b720063b47e1fec00a0"></a><!-- doxytag: member="ambhas::sunlib::sun::set_rise" ref="a759c8e36b8787b720063b47e1fec00a0" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def <a class="el" href="classambhas_1_1sunlib_1_1sun.html#a759c8e36b8787b720063b47e1fec00a0">ambhas.sunlib.sun.set_rise</a> </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">
Returns the sun set and rise time
</pre></div> 
<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00133">133</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<a class="anchor" id="a7463e325e5c741f3d43cf6c4435cd126"></a><!-- doxytag: member="ambhas::sunlib::sun::solar_zenith_angle" ref="a7463e325e5c741f3d43cf6c4435cd126" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def <a class="el" href="classambhas_1_1sunlib_1_1sun.html#a7463e325e5c741f3d43cf6c4435cd126">ambhas.sunlib.sun.solar_zenith_angle</a> </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>tc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">
Input:
    tc:     local time in hours
Output:
    sza:    solar zenith angle in radian
</pre></div> 
<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00091">91</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a51d1a09929fc7cb88ff2ed2b09e93708"></a><!-- doxytag: member="ambhas::sunlib::sun::doy" ref="a51d1a09929fc7cb88ff2ed2b09e93708" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#a51d1a09929fc7cb88ff2ed2b09e93708">ambhas::sunlib.sun::doy</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00043">43</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<a class="anchor" id="a60e5d58a61ed47ad507123fb014d0161"></a><!-- doxytag: member="ambhas::sunlib::sun::dr" ref="a60e5d58a61ed47ad507123fb014d0161" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#a60e5d58a61ed47ad507123fb014d0161">ambhas::sunlib.sun::dr</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00043">43</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<a class="anchor" id="a7f1a949d69b309ea54f797fcfcec0734"></a><!-- doxytag: member="ambhas::sunlib::sun::lon_deg" ref="a7f1a949d69b309ea54f797fcfcec0734" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#a7f1a949d69b309ea54f797fcfcec0734">ambhas::sunlib.sun::lon_deg</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00043">43</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<a class="anchor" id="ae89daab3f0dfe9b266bf799841d09bf5"></a><!-- doxytag: member="ambhas::sunlib::sun::N" ref="ae89daab3f0dfe9b266bf799841d09bf5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#ae89daab3f0dfe9b266bf799841d09bf5">ambhas::sunlib.sun::N</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00118">118</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<a class="anchor" id="ad323cbbcfd71b3b895a951f3037b54a9"></a><!-- doxytag: member="ambhas::sunlib::sun::ze" ref="ad323cbbcfd71b3b895a951f3037b54a9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classambhas_1_1sunlib_1_1sun.html#ad323cbbcfd71b3b895a951f3037b54a9">ambhas::sunlib.sun::ze</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="sunlib_8py_source.html#l00043">43</a> of file <a class="el" href="sunlib_8py_source.html">sunlib.py</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/tomer/svn/ambhas/ambhas/<a class="el" href="sunlib_8py_source.html">sunlib.py</a></li>
</ul>
</div><!-- contents -->
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceambhas.html">ambhas</a>      </li>
      <li class="navelem"><a class="el" href="namespaceambhas_1_1sunlib.html">sunlib</a>      </li>
      <li class="navelem"><a class="el" href="classambhas_1_1sunlib_1_1sun.html">sun</a>      </li>

    <li class="footer">Generated on Sat Jul 21 2012 12:26:09 for AMBHAS by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
   </ul>
 </div>


</body>
</html>
